home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr18 / pwzmod11.zip / PWZMOD.DOC < prev    next >
Text File  |  1993-05-21  |  19KB  |  428 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                  PWZMOD
  10.                          A Batch Upload Builder
  11.                         For ProComm+ For Windows
  12.  
  13.             Copyright (c) 1993 by Creative Systems Software
  14.                        Written by Shawn Fessenden
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.          The author can be reached in the U'NI-net PROCOMM echo
  50.           or the DOS-TIPS or CHIT-CHAT echos. The address is:
  51.  
  52.                             Shawn Fessenden
  53.                        320.5 North Avenue, Lower
  54.                             Aurora, IL 60505
  55.  
  56.           The phone number is (708) 892-4967. Weekdays between
  57.    7:15 a.m. and 6:15 p.m. you'll reach The Abyss BBS at this number.
  58.  
  59.  
  60.  
  61. 1. WHAT IT IS
  62. ────────────────────────────────────────────────────────────────────────
  63.  
  64.         PWZMOD is a PC+/Win Aspect script that allows building batch
  65. uploads conveniently and quickly in the PC+/Win environment. PWZMOD
  66. features easy point & shoot selection of file names to upload and a
  67. "smart" directory pick list. Checkbox controls allow keeping the upload
  68. list intact after upload completion, deleting uploaded files and saving
  69. configuration on exit. Pushbutton controls add and remove file names
  70. from the upload list as well as directory names to and from the
  71. directory pick list. A comprehensive .ini file is read upon startup for
  72. configuration parameters, and can be edited to enable or change features
  73. not included in the user interface. After the upload batch is built,
  74. PWZMOD calls Omen Technology's DSZ (TM) Zmodem protocol via an included
  75. .pif file to upload the listed files. The .pif file allows calling any
  76. protocol driver if you do not have or do not wish to use DSZ (TM).
  77.  
  78.         Because the script was originally intended to use a Zmodem
  79. protocol, the .pif file is called PWZMOD.PIF. If you choose to use a
  80. protocol than Omen's DSZ (TM), the .pif can be modified to call whatever
  81. protocol driver you wish. You must change a line in the PWZMOD.INI file
  82. also, to tell the script what command line to pass to the protocol.
  83.  
  84.  
  85. 2. WHAT YOU NEED
  86. ────────────────────────────────────────────────────────────────────────
  87.  
  88.         Windows 3.1, PC+/Win ver. 1.01 (PWZMOD has not been tested with
  89. ver. 1) and Omen Technology's DSZ (TM) or other DOS protocol driver.
  90. PWZMOD takes less than 6K alltogether. A 386 running in Windows Enhanced
  91. mode is the minimum recommended for maximum utility, but any machine
  92. running at least Standard mode will do. If not running 386 Enh mode, you
  93. will not be able to switch away from the protocol once it starts.
  94.  
  95.  
  96. 3. QUICK START
  97. ────────────────────────────────────────────────────────────────────────
  98.  
  99.         Copy PWZMOD.PIF to your .pif subdirectory, then copy PWZMOD.WAX to
  100. your aspect script subdirectory and run it. Keep the icon in the same
  101. directory as the .wax file. You can replace it if you want with one of
  102. your own. Just name the icon PWZMOD.ICO. When you run PWZMOD the first
  103. time, It will create a default .ini file in your Windows subdirectory,
  104. check out your system and set itself up accordingly. You will get a
  105. message stating that PWZMOD is assuming its .pif file is in your path.
  106. If this is not so, move the .pif file to a directory that is in the
  107. path, or see "5. THE .INI FILE" for further information.
  108.  
  109.         You may get a message stating that "ComX AutoAssign" (where X is
  110. the com port number of your modem) either doesn't exist in the [386 Enh]
  111. section of your system.ini, or is set to "Always Warn" or "Idle". While
  112. not a problem, Windows will inform you that two applications are trying
  113. to access the same com port at the same time when PWZMOD calls your DOS
  114. protocol. To avoid these warnings, open the 386 Enhanced icon in Control
  115. Panel and set your modem's com port to "Never Warn".
  116.  
  117.        If you are not running in 386 Enhanced mode, none of this applies
  118. to you because you will not be able to switch away from the DOS protocol
  119.  
  120.  
  121.  
  122. once it starts. I realize these warnings are bothersome if you need
  123. things set up the way you have them and PWZMOD always pops these
  124. warnings up at you. Ver. 1.1 of the script will allow disabling these
  125. messages. When you set up the script this way, PWZMOD will call Omen's
  126. DSZ (TM) when you press OK. If you need it set up for another protocol,
  127. read "5. THE .INI FILE".
  128.  
  129.  
  130. 4. USING THE SCRIPT.
  131. ─────────────────────────────────────────────────────────────────────────
  132.  
  133.         On the left of the window are (from top to bottom) the current
  134. directory, a box for entering a new directory name or a name to be
  135. searched for, the directory pick list, the Save Config button, and the
  136. configuration checkboxes. In the middle is the current directory file
  137. list box, and on the right is the current upload list with the total
  138. number of files and total number of bytes to upload on top. The command
  139. buttons Add, Remove, Cancel and OK are on the bottom.
  140.  
  141.         To select files from the current directory to place in the
  142. upload list, select them from the current directory box (middle) and
  143. press Add. Multiple file selections are allowed (Shift-Click to select a
  144. range, Ctrl-Click to toggle a selection or select multiple files out of
  145. the listed order). Alternatively, you can double-click on a file name to
  146. add it to the Upload List. Your directory tree can also be navigated by
  147. double-clicking on the parent directory (..) or subdirectory names (in
  148. brackets). You can change drives by double-clicking on the drive
  149. letters.
  150.  
  151.         When you press Add, the files will appear in the Upload List box
  152. and the total number of files listed and total bytes of all files will
  153. be displayed above the Upload List.
  154.  
  155.         To remove files from the upload list, select them from the
  156. Upload List and press Remove. Multiple selections are allowed.
  157.  
  158.         To add directory names to the directory pick list, change to the
  159. directory you wish to add (either navigate there using the current
  160. directory file list or enter a name in the Other Directories edit box
  161. and click once in the current directory file list box) and press Add. As
  162. long as no files are selected in the current directory file list, the
  163. current directory is added to the directory pick list (DPL). If the
  164. directory already exists in the DPL then it is not added again.
  165.  
  166.         To remove directory names from the DPL, change to the directory
  167. you wish to remove and press Remove. As long as no files are selected in
  168. the Upload List, the current directory is removed from the DPL.
  169.  
  170.         To use the DPL, drop the list with the little arrow to the right
  171. of the box and click on a directory. To use the "smart" feature, enter a
  172. few characters of the directory you want to change to in the Other
  173. Directories text box and click in the current directory file list box.
  174. Note that the script will only search directories in the DPL. The
  175. directory tree is not searched. If the script can't find a decent match
  176. in the DPL, it'll switch to the root directory of the current drive.
  177.  
  178.         The script saves the current configuration when exiting by
  179. default. The current configuration consists of all the check boxes and
  180.  
  181.  
  182.  
  183. the DPL itself, as well as some parameters not currently accessable via
  184. the user interface. If you wish to save the current configuration
  185. without exiting press the Save Configuration pushbutton. Notice that the
  186. Save button is disabled when you start the script. This was done to
  187. prevent accidentally changing the configuration. To enable the Save
  188. Configuration pushbutton, toggle the Save Config on Exit checkbox. Once
  189. the button is enabled, it remains enabled until you use it.
  190.  
  191.  
  192. 4.1 SCRIPT USE NOTES
  193. ────────────────────────────────────────────────────────────────────────
  194.  
  195.         The Add pushbutton is the default button. If you press the
  196. Enter key at any time while interacting with the script window the add
  197. button will be pushed.
  198.  
  199.         For those of you who hate mousing around, press Alt-T (oTher
  200. directories), type a few characters of the directory you want to change
  201. to (that is already in the DPL) and press Enter. As long as no files are
  202. selected in the current directory list box, the script will simply
  203. change to that directory. Since the directory already exists in the DPL,
  204. it will not be added.
  205.  
  206.         To change through directories in the DPL, press Alt-T, Tab
  207. (highlights DPL box but does not drop) and press the Up or Down arrows.
  208.  
  209.         Press Alt-F (Files) to move into the current directory file list
  210. box. Press the first letter of the name of the group of files you wish
  211. to move to (they are listed in alphabetical order) and the highlight
  212. will jump there. Unfortunately, there is no way I know of to make
  213. multiple selections via Aspect scripts with the keyboard. You can still
  214. move the highlight with the arrow keys and press enter to add them to
  215. the upload list.
  216.  
  217.         Press Alt-U (Upload list) to move into the Upload List. To
  218. remove a highlighted file, press Alt-R. Since the full pathname of files
  219. in the Upload list is displayed, first-character filename jumping simply
  220. will not fly here. You're stuck with the mouse or multiple Up and Down
  221. Arrow keys.
  222.  
  223.         The entire script is accessable with hot-keys, but experiment
  224. before depending on keystrokes: apparently the Aspect language does not
  225. require an Alt press with a hot-key for that hot-key to take effect in
  226. all situations. Particularly if nothing is highlighted when a key is
  227. pressed.
  228.  
  229.         You don't need to be on-line to build an Upload List. Build the
  230. Upload List, turn on Keep Upload List and press Cancel or go ahead and
  231. dial a BBS (although the PWZMOD window is kinda obnoxious). If you opt
  232. to press Cancel with Keep Upload List turned on, the next time you start
  233. the script your list will be intact.
  234.  
  235.         If you double-click a file name in the Upload List, the current
  236. directory gets added to the DPL. I know its strange, but remember that
  237. the Add button is the default here, and a double-click selects what you
  238. clicked on and then presses the default button. Since you can't Add to
  239. anything from the Upload List, the script assumes you meant to Add the
  240.  
  241.  
  242.  
  243. current directory to the DPL. A future version of the script will check
  244. for and correct this odd behavior (a double-click in the Upload List
  245. should, IMHO, Remove a file from the list).
  246.  
  247.  
  248.         More operation notes are available in "6. SCRIPT PROGRAMMING
  249. NOTES". In particular, forcing ver 1.0 to use a different protocol (the
  250. mechanism I had planned for doing this did not make it into ver. 1.0,
  251. but its still possible because PWZMOD uses a .pif file to control the
  252. DOS session that the protocol runs in), forcing a temporary directory
  253. and forcing the script to use a ramdrive for a temporary directory (that
  254. is not defined as the DOS env. vars. TEMP or TMP). Yes siree Bob! All
  255. sortsa stuff is possible, and you even get the source and 1 year of free
  256. upgrades for $10! Um -- I should mention that you don't need to get the
  257. source to do any of these useful things. Just read section 6.
  258.  
  259.  
  260. 5. THE .INI FILE
  261. ────────────────────────────────────────────────────────────────────────
  262.  
  263.         The .ini file for PWZMOD looks like this:
  264.  
  265. [Configuration]
  266. KeepList=1
  267. DelIfSuccessful=0
  268. SaveConfig=0
  269. LastDir=c:\install
  270. ForceTemp=
  271.  
  272. [Zmod]
  273. ZmodPath=c:\windows\pif
  274. ZmodCmdLine=sz -m
  275.  
  276. [DirPickList]
  277. 1DPL=c:\install
  278. 2DPL=c:\sw\pw\ul
  279. 3DPL=c:\usr\shawn\text
  280. 4DPL=c:\sw\games\new_stuf
  281.  
  282.         Values of 1 and 0 mean true and false, respectively. There are
  283. others you can use. True values are: 1, affirmative, excellent, on,
  284. true, way or any string that is equal to or contains "yes". False values
  285. are: 0, bogus, false, negative, off or any string that is equal to or
  286. contains "no". String searches are not case sensitive. Like, WAY means
  287. true and NO WAY means false.
  288.  
  289.  
  290. 5.1 THE [Configuration] SECTION
  291. ────────────────────────────────────────────────────────────────────────
  292.  
  293.         KeepList        - Use same Upload List next time?
  294.  
  295.         DelIfSuccessful - Delete files after upload?  (At some point,
  296.                           I plan to have PWZMOD read the status file
  297.                           generated by DSZ (TM) and decide which files
  298.                           were actually sent. Only those would be
  299.                           deleted. At the moment, all files in the
  300.                           Upload List are deleted.)
  301.  
  302.         SaveConfig      - Save configuration when script terminates?
  303.  
  304.  
  305.  
  306.  
  307.         LastDir         - The last directory used by PWZMOD. The dir
  308.                           shown is for illustration only.
  309.  
  310.         ForceTemp       - Directory to use as a temporary directory.
  311.                           If you don't want PWZMOD to use the env. vars.
  312.                           RAMDSK, TEMP or TMP you can name a directory
  313.                           here to store temporary files in. All of these
  314.                           are deleted except the Upload List when Keep
  315.                           Upload List is checked.
  316.  
  317.  
  318. 5.2 THE [Zmod] SECTION
  319. ────────────────────────────────────────────────────────────────────────
  320.  
  321.         ZmodPath        - Path to the .pif file that controls the
  322.                           external protocol. If this line is not
  323.                           present, you get a warning stating that
  324.                           PWZMOD.PIF is assumed to be in the command
  325.                           search path. The path shown is for
  326.                           illustration only.
  327.  
  328.         ZmodCmdLine     - Switches to add to the command line used to
  329.                           invoke PWZMOD.PIF. This is where you can add
  330.                           your own goodies.
  331.  
  332.         Note: To have the script ready by the 5/10 promised release
  333. date, ForceCmd=(forced command line) has not been included in ver. 1.0.
  334. It has not been proven reliable yet. This is the mechanism used to call
  335. another protocol instead of DSZ (TM). However, you CAN have the .pif
  336. call a batch file that calls the protocol of your choice with all the
  337. necessary switches you like to use. See "6. SCRIPT PROGRAMMING NOTES"
  338. for further info.
  339.  
  340.  
  341. 5.3 THE [DirPickList] SECTION
  342. ────────────────────────────────────────────────────────────────────────
  343.  
  344.         This is where the DPL is stored. You can enter directories here
  345. by hand if you wish. Shown are a few from my drive so you can get the
  346. idea. Be careful about typing them in though; they are checked for
  347. validity before the script attempts to switch to them, but if they're
  348. not valid there's no way of getting rid of them short of editing them
  349. out of the .ini file. Please note that this also means you'll have to
  350. edit a directory out of the .ini that was in the DPL when it existed but
  351. that directory has since been deleted. For simplicity's sake, remove it
  352. from the DPL before you delete it, or once one is there go back and
  353. create it again and remove it from the DPL, then delete it.
  354.  
  355.  
  356. 6. SCRIPT PROGRAMMING NOTES
  357. ────────────────────────────────────────────────────────────────────────
  358.  
  359.         Currently, the script uses files to do all its stuff. On some
  360. systems, this can get excrucatingly slow. The files are no big deal
  361. though, so any decent cache will take care of your drive speed. One of
  362. the major improvements will be to use arrays instead.
  363.  
  364.  
  365.  
  366. 6.1 TEMPORARY FILE DIRECTORY AND RAMDRIVES
  367. ────────────────────────────────────────────────────────────────────────
  368.  
  369.         The script looks for temporary directories in this order: The
  370. env. vars. RAMDSK, TEMP and TMP. If it doesn't find any of those it uses
  371. the default Aspect directory. If you do use a TEMP or TMP and don't want
  372. PWZMOD putting its temporary files there, use the ForceTemp= line in
  373. PWZMOD.INI to tell the script where to put temporary files. If you have
  374. a ram drive available you can create the env. var. RAMDSK to point to
  375. that drive (set ramdsk=d:). If you don't want to clutter up your
  376. environment then use the ForceTemp= line. This will speed things up as
  377. much as possible until the arrays go in. Any temporary directory found,
  378. be it defined with an env. var., in the .ini file or the default Aspect
  379. directory, are verified before use. If a potential temporary directory
  380. is invalid, the root of the default drive will be used.
  381.  
  382.  
  383.  
  384. 6.2 USING A DIFFERENT PROTOCOL
  385. ────────────────────────────────────────────────────────────────────────
  386.  
  387.         If you don't want to use Omen's DSZ (TM) as your upload
  388. protocol, you're kinda stuck writing a batch file to start whatever
  389. protocol you want to use. Change the application name in PWZMOD.PIF to
  390. the name of your batch file. When the batch executes, the command line
  391. parameters will be in this order:
  392.  
  393. %0 = [drive:\directory\]dsz.com
  394. %1 = portx
  395. %2 = (com port base address),(irq #)
  396. %3 = speed
  397. %4 = (serial port speed)
  398. %5 = handshake
  399. %6 = on
  400. %7 = sz (First parameter in ZmodCmdLine)
  401. %8 = -m (Second parameter in ZmodCmdLine)
  402. %9 = (drive, path and filename of the list of files to upload)
  403.  
  404.         What you'll mainly be interested in is the filename and
  405. location, assuming you already know what port address and irq you're
  406. using and what speed your serial port is at. The name of the file is
  407. always ULIST.TXT, and presumably you'll also know where it is if you set
  408. up any of the env. vars. that PWZMOD looks for. At any rate, if you add
  409. any parameters to the ZmodCmdLine= line in PWZMOD.INI then you'll have
  410. to shift the parameters to get the filename to %9 if you need it.
  411. Everything will be constant up to %6. Any modifications to the
  412. ZmodCmdLine show up at %7 & beyond.
  413.  
  414.         Just have your batch file call the protocol as you normally
  415. would from your old DOS comm program or from the DOS command line and
  416. pick up whatever parameters you need. Needless to say, the protocol must
  417. be able to accept a file of filenames to upload or the whole idea is
  418. useless <G>.
  419.  
  420.         If you have any problems trying to make any particular protocol
  421. work, just give me a holler on the U'NI-net PROCOMM echo, or at (708)
  422. 892-4967 & I'll do my best to help out. If when you call my house you
  423. get an answer tone instead of me, log on and leave me a note. If you get
  424. a FAX answer tone try to fax me a note. The latest version of PWZMOD
  425. will always be available for download if you're lucky enough to get my
  426. computer.
  427.  
  428.